Google Git
Sign in
android / platform / external / rust / crates / heck / f79675843ab4abd3d829c2cc59006f424e55beb4
commitf79675843ab4abd3d829c2cc59006f424e55beb4[log] [tgz]
authorMatthew Maurer <mmaurer@google.com>Thu Sep 08 13:32:42 2022 +0000
committerAutomerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>Thu Sep 08 13:32:42 2022 +0000
treed350a75e75fb66b535b5114ce5f230f698e3ab2c
parent59b88d41e2fc9b37964c59ed0abd2ec5bad16928 [diff]
parentedbccd7b784e91041e717dae0b7bac630098bbe5 [diff]
Version split - 0.3.3 -> legacy, 0.4 -> current am: 8e19def420 am: 56b36780b4 am: d759dff9e1 am: edbccd7b78 Original change: https://android-review.googlesource.com/c/platform/external/rust/crates/heck/+/2209841 Change-Id: Idb963b5bc2a8c53b2b89eab36f51aa11de1ff899 Signed-off-by: Automerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>
tree: d350a75e75fb66b535b5114ce5f230f698e3ab2c
  1. 0.3.3/
  2. src/
  3. LICENSE ⇨ LICENSE-APACHE
  4. NOTICE ⇨ LICENSE
  5. .cargo_vcs_info.json
  6. .gitignore
  7. Android.bp
  8. Cargo.toml
  9. Cargo.toml.orig
  10. cargo2android.json
  11. CHANGELOG.md
  12. LICENSE-APACHE
  13. LICENSE-MIT
  14. METADATA
  15. MODULE_LICENSE_APACHE2
  16. OWNERS
  17. README.md
README.md

heck is a case conversion library

I specifically requested the opposite of this.

This library exists to provide case conversion between common cases like CamelCase and snake_case. It is intended to be unicode aware, internally consistent, and reasonably well performing.

Definition of a word boundary

Word boundaries are defined as the “unicode words” defined in the unicode_segmentation library, as well as within those words in this manner:

  1. All underscore characters are considered word boundaries.
  2. If an uppercase character is followed by lowercase letters, a word boundary is considered to be just prior to that uppercase character.
  3. If multiple uppercase characters are consecutive, they are considered to be within a single word, except that the last will be part of the next word if it is followed by lowercase characters (see rule 2).

That is, “HelloWorld” is segmented Hello|World whereas “XMLHttpRequest” is segmented XML|Http|Request.

Characters not within words (such as spaces, punctuations, and underscores) are not included in the output string except as they are a part of the case being converted to. Multiple adjacent word boundaries (such as a series of underscores) are folded into one. (“hello__world” in snake case is therefore “hello_world”, not the exact same string). Leading or trailing word boundary indicators are dropped, except insofar as CamelCase capitalizes the first word.

Cases contained in this library:

  1. UpperCamelCase
  2. lowerCamelCase
  3. snake_case
  4. kebab-case
  5. SHOUTY_SNAKE_CASE
  6. Title Case
  7. SHOUTY-KEBAB-CASE

Contributing

PRs of additional well-established cases welcome.

This library is a little bit opinionated (dropping punctuation, for example). If that doesn't fit your use case, I hope there is another crate that does. I would prefer not to receive PRs to make this behavior more configurable.

Bug reports & fixes always welcome. :-)

MSRV

The minimum supported Rust version for this crate is 1.32.0. This may change in minor or patch releases, but we probably won't ever require a very recent version. If you would like to have a stronger guarantee than that, please open an issue.

License

heck is distributed under the terms of both the MIT license and the Apache License (Version 2.0).

See LICENSE-APACHE and LICENSE-MIT for details.